amapi.h

Go to the documentation of this file.

/*********************************************************************
 *
 *           Copyright (c) 2021 by Visuality Systems, Ltd.
 *
 *************************************************************************
 * FILE NAME     : $Workfile:$
 * ID            : $Header:$
 * REVISION      : $Revision:$
 *--------------------------------------------------------------------
 * DESCRIPTION   : Authentication API
 *--------------------------------------------------------------------
 * MODULE        : NQ
 * DEPENDENCIES  :
 *************************************************************************/

#ifndef _AMAPI_H_ 
#define _AMAPI_H_

#include "cmapi.h"

/* -- Constants -- */

/* security levels: */
#define AM_MAXSECURITYLEVEL 4   
/* available encryption algorithms: */

#define AM_CRYPTER_NONE     0   
#define AM_CRYPTER_LM       1   
#define AM_CRYPTER_NTLM     2   
#define AM_CRYPTER_LM2      3   
#define AM_CRYPTER_NTLM2    4   
/* security mechanisms: */
#define AM_MECH_NTLMSSP     1   
#define AM_MECH_KERBEROS    2   
/* -- Structures --*/

typedef struct {
    NQ_CHAR name[CM_BUFFERLENGTH(NQ_CHAR, 256)];     
    NQ_CHAR realm[CM_BUFFERLENGTH(NQ_CHAR, 256)];    
}
AMDomainA;

typedef struct {
    NQ_WCHAR name[CM_BUFFERLENGTH(NQ_WCHAR, 256)];   
    NQ_WCHAR realm[CM_BUFFERLENGTH(NQ_WCHAR, 256)];  
}
AMDomain;

/* Account credentials */
typedef struct {
    AMDomainA domain;                                   
    NQ_CHAR user[CM_BUFFERLENGTH(NQ_CHAR, 257)];        
    NQ_CHAR password[CM_BUFFERLENGTH(NQ_CHAR, 257)];    
    NQ_UINT type;                                       
}
AMCredentialsA;

typedef struct {
    AMDomain domain;                                    
    NQ_WCHAR user[CM_BUFFERLENGTH(NQ_WCHAR, 257)];      
    NQ_WCHAR password[CM_BUFFERLENGTH(NQ_WCHAR, 257)];  
    NQ_UINT type;                                       
}
AMCredentials;

#define AM_CREDENTIALS_PASSWORD_PLAINTEXT   0
#define AM_CREDENTIALS_PASSWORD_MD4         1

/* -- Functions -- */

NQ_BOOL amStart(void);

void amShutdown(void);

#if defined(UD_NQ_INCLUDECIFSCLIENT) || defined(DOXYGEN)

void amClientDefineLevel(NQ_UINT level, NQ_UINT crypter1, NQ_UINT crypter2, NQ_UINT32 mehanisms);

void amSetNonSecureAuthentication(NQ_BOOL enableNonSecureAuthentication);

#endif /* UD_NQ_INCLUDECIFSCLIENT */

void amCredentialsAsciiiToW(AMCredentials *to, const AMCredentialsA *from);

void amCredentialsInit(AMCredentials *creds, const NQ_WCHAR *domain, const NQ_WCHAR *user, const NQ_WCHAR *password, NQ_UINT type);

void amCredentialsInitA(AMCredentialsA *creds, const NQ_CHAR *domain, const NQ_CHAR *user, const NQ_CHAR *password, NQ_UINT type);

#endif /* _AMAPI_H_ */